home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / comm / ca29_3.zip / REMAP.DOC < prev    next >
Text File  |  1992-11-30  |  28KB  |  990 lines
  1. COM-AND Remap Script
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.           -------------------------------------------
  13.                 COM-AND Remap Script
  14.           Script based compiler for COM-AND remapping
  15.           -------------------------------------------
  16.  
  17.  
  18.  
  19.  
  20.     COM-AND, and the REMAP script are copyright 1992 by CABER Soft-
  21.     ware.  COM-AND is distributed freely and may be copied by anyone
  22.     for any number of machines, for purposes of evaluation.  The
  23.     author offers COM-AND and its accessory programs as "shareware".
  24.     If you USE the program after evaluating it, you MUST pay for it.
  25.  
  26.  
  27.  
  28.     The complete user license and registration information is to be
  29.     found in the file REGISTER.DOC.  Limitations on redistribution
  30.     of COM-AND are set out in the file VENDOR.DOC.    These two files
  31.     are included with the COM-AND program release.
  32.  
  33.  
  34.  
  35.                  CABER Software
  36.                  R. (Scott) McGinnis
  37.                  P.O. Box 3607 Mdse Mart
  38.                  Chicago, IL 60654-0607
  39.  
  40.                  GEnie, Delphi: TARTAN
  41.                  CIS .......... 73147,2665
  42.                  Internet ..... 73147.2665@compuserve.com
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54. Version 1.2: 921012
  55.  
  56. COM-AND Remap Script
  57.  
  58.  
  59.                  Table of Contents
  60.                  -----------------
  61.  
  62. I.    Introduction  .............................................. page 1
  63.  
  64.     A. What is COM-AND ......................................... page 1
  65.     B. Terminal Emulation ...................................... page 1
  66.     C. The REMAP Script ........................................ page 1
  67.  
  68. II.    Running REMAP.CMD .......................................... page 2
  69.  
  70. III.    REMAP source files ......................................... page 3
  71.  
  72.     A. Comments ................................................ page 3
  73.     B. Section names ........................................... page 3
  74.     C. Redefinitions ........................................... page 3
  75.     D. Remapped keys within redefinitions ...................... page 5
  76.  
  77. IV.    DOORWAY Remaps ............................................. page 6
  78.  
  79. V.    Program Requirements ....................................... page 7
  80.  
  81. VI.    Program and Author Information    ............................ page 8
  82.  
  83.  
  84.                 Appendices
  85.                 ----------
  86.  
  87.  
  88. A.    File structures ............................................ page 9
  89.  
  90. B.    Syntax ..................................................... page 10
  91.  
  92. C.    Tokens ..................................................... page 11
  93.  
  94. D.    Unusual Remaps ............................................. page 12
  95.  
  96. E.    REMAPS.TXT (source file) ................................... page 13
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109. Version 1.2: 921012
  110.  
  111. COM-AND Remap Script                             Page   1
  112.  
  113.  
  114. I.    Introduction
  115.  
  116.  
  117.     A. What is COM-AND?
  118.  
  119.  
  120.        COM-AND for the IBM PC and compatibles is a communications program
  121.        for use by itself, or for use with several integrated accessory
  122.        programs (which themselves may be used independently of COM-AND).
  123.        COM-AND provides standard comm program functions:  a dialing
  124.        directory, macros, disk logging, binary and ASCII file transfers,
  125.        scripted execution and terminal emulation...
  126.  
  127.  
  128.     B. Terminal Emulation
  129.  
  130.        COM-AND supports terminal emulation through 'display emulation',
  131.        'translation', and 'keyboard remapping' functions.  These are
  132.        independent...  VT100 display emulation may be combined with the
  133.        VT100 keyboard remap supplied, or the display emulation may be
  134.        combined with a different remap (one constructed to a different
  135.        set of preferences).
  136.  
  137.  
  138.     C. The REMAP script
  139.  
  140.        The script REMAP.CMD is a compiler of sorts.  It defines 'codes'
  141.        for each key COM-AND can detect (COM-AND doesn't detect all keys)
  142.        and a simple syntax for their redefinition.    REMAP.CMD also
  143.        allows several redefinitions combined in one source file; each
  144.        set is given its own unique name.
  145.  
  146.  
  147.        This document discusses the function of the REMAP.CMD script,
  148.        and the syntax used in source files given to REMAP.CMD.
  149.  
  150.        If all this seems overly complex, or if you have questions about
  151.        COM-AND's terminal emulation, feel free to write the author.  I
  152.        am very interested in every reaction to COM-AND.
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164. Version 1.2: 921012
  165.  
  166. COM-AND Remap Script                             Page   2
  167.  
  168.  
  169. II.    Running REMAP.CMD
  170.  
  171.  
  172.     The REMAP script is invoked through COM-AND's script processor (F2).
  173.     When invoked, REMAP opens a window offering a menu of choices.    The
  174.     choices are:
  175.  
  176.  
  177.     1) Compile source into a new remap file (COM-AND.RMP)
  178.  
  179.        Compilation of a source file produces a new COM-AND.RMP file
  180.        for use by COM-AND.    The source file name is requested; when
  181.        the source file is opened it is scanned once for 'sections'.
  182.  
  183.        If the source file contains one or more 'sections' (i.e. NAME
  184.        commands) the section names are listed in a new window, and
  185.        one must be selected.
  186.  
  187.        When a source file contains no sections, or when a section has
  188.        been selected, a new window is opened and the compilation begins.
  189.        Lines of text are displayed within the new window as they are
  190.        processed.  Press ESC to pause the compilation.
  191.  
  192.     2) Syntax check a source file
  193.  
  194.        REMAP allows a syntax check as well as compile.  A syntax check
  195.        results in no change to the current COM-AND.RMP.
  196.  
  197.     3) Search for files (Alt-F)
  198.  
  199.        REMAP allows you to search for files using the Alt-F file
  200.        directory function of COM-AND.
  201.  
  202.     4) Edit a file
  203.  
  204.        REMAP allows you to invoke an editor on a source file (the syntax
  205.        for the invocation is assumed - you may wish to change it).    When
  206.        you exit the editor, you are returned to COM-AND and REMAP.
  207.  
  208.     5) Turn remap on (using current COM-AND.RMP map file)
  209.  
  210.     6) Turn remap off
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219. Version 1.2: 921012
  220.  
  221. COM-AND Remap Script                             Page   3
  222.  
  223.  
  224. III.    REMAP source files
  225.  
  226.  
  227.     REMAP expects an ASCII file as source for the compilation.  ASCII
  228.     files are prepared by text editors (e.g.  EDLIN).  Word processors
  229.     usually do not emit ASCII files...  if you wish to use a word pro-
  230.     cessor to prepare a source file for REMAP, be sure it gives you
  231.     ASCII output (often called non-document format).
  232.  
  233.  
  234.     [NOTE:    The REMAP script allows you to invoke a text editor or word
  235.     processor from within the script itself.  Modify the first line of
  236.     the script to declare the complete program name (e.g.  C:\PE.EXE).
  237.     If you leave it blank, REMAP queries for a program name.  The value
  238.     "INTERNAL" invokes COM-AND's internal editor.]
  239.  
  240.     [NOTE: FileMgr.CMD defaults to COM-AND's INTERNAL editor in its
  241.     distributed form, and after a failure to load the editor you specify
  242.     (if you change the script.  Please refer to the document CASCRIPT.
  243.     DOC for a discussion of this editor.]
  244.  
  245.     Lines of source to REMAP.CMD must be  limited in length to 80
  246.     characters. Source files contain three types of lines:
  247.  
  248.     A. Comments
  249.  
  250.        Comment lines are blank, or begin with ";" or "*".  They are
  251.        ignored by the compiler.
  252.  
  253.     B. Section names
  254.  
  255.        The source file may (optionally) be divided into several sections
  256.        through the inclusion of "NAME = ..." command lines.  REMAP scans
  257.        the file before compilation; if section names are found, a window
  258.        is opened and you are asked to select a section to compile.
  259.  
  260.     C. Redefinitions
  261.  
  262.        All other lines of a source file are redefinitions.    A redefin-
  263.        ition command declares a given key is redefined as another key
  264.        or keys.  For example:
  265.  
  266.        A = B    ; redefines the 'A' key as 'B'
  267.        0x1a = AltX    ; Redefines control-z (0x1a) as Alt-X
  268.        0x80 = F2 "remap.cmd!"
  269.  
  270.  
  271.  
  272.  
  273.  
  274. Version 1.2: 921012
  275.  
  276. COM-AND Remap Script                             Page   4
  277.  
  278.  
  279. III.    REMAP source files (continued)
  280.  
  281.  
  282.     C. Redefinitions (continued)
  283.  
  284.        The last example requires some explanation...  0x80 is 80 hex.
  285.        to get an 80 hex using the keyboard, press and hold the ALT key
  286.        while typing 1 2 8 on the numeric pad (128 decimal is 80 hex).
  287.  
  288.        The last example declares that when you type 80 hex (alt-1-2-8),
  289.        COM-AND sees F2, then the string "remap.cmd" then a carriage
  290.        return (the "!" at the end is a carriage return).
  291.  
  292.        You may declare a string using the usual conventions for macro
  293.        strings or m